Cisco-IOS-XR-man-ipsla-cfg API API Reference
API generated from Cisco-IOS-XR-man-ipsla-cfg@2015-11-09.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key  Mandatory  OptionalPaths
IPSLA - Update
Update operation of resource: ipsla
ipslabody object
Request Content-Types: application/json
Request Example
{ "interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
}, {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create MPLSLM instance with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create MPLSLM instance with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create MPLSLM instance with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create MPLSLM instance with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create MPLSLM instance with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create MPLSLM instance with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this MPLSLM instance
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this MPLSLM instance "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
},
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this MPLSLM instance "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this MPLSLM instance
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "mask": "string", IP netmask for target
"address": "string" No description
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create MPLSLM instance with specified type
"tag": "string", Add a tag for this MPLSLM instance
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this MPLSLM instance
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" No description
}
}, "mask": "string", IP netmask for target
"address": "string" No description
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this MPLSLM instance
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
"recurring": "null", probe to be scheduled automatically every day "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}, { "create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}, "create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, { "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
},
"create": "null", Create MPLSLM instance with specified type
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
}, "frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"type": "string" Configure IPSLA Responder port type
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
},
"create": "null", Create MPLSLM instance with specified type "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
},
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, {
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}
}, "low-memory": "integer", Configure low memory water mark (default 20M)
range: "0..4294967295"
default: 20M)" "key-chain": "string" Use MD5 authentication for IPSLA control\nmessage
}
}, "enable": "null", Starts the responder process {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPSLA - Create
Create operation of resource: ipsla
ipslabody object
Request Content-Types: application/json
Request Example
{ "interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
}, {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create MPLSLM instance with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create MPLSLM instance with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create MPLSLM instance with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create MPLSLM instance with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create MPLSLM instance with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create MPLSLM instance with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this MPLSLM instance
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this MPLSLM instance "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
},
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this MPLSLM instance "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this MPLSLM instance
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "mask": "string", IP netmask for target
"address": "string" No description
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create MPLSLM instance with specified type
"tag": "string", Add a tag for this MPLSLM instance
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this MPLSLM instance
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" No description
}
}, "mask": "string", IP netmask for target
"address": "string" No description
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this MPLSLM instance
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
"recurring": "null", probe to be scheduled automatically every day "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}, { "create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}, "create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, { "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
},
"create": "null", Create MPLSLM instance with specified type
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
}, "frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"type": "string" Configure IPSLA Responder port type
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
},
"create": "null", Create MPLSLM instance with specified type "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
},
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, {
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}
}, "low-memory": "integer", Configure low memory water mark (default 20M)
range: "0..4294967295"
default: 20M)" "key-chain": "string" Use MD5 authentication for IPSLA control\nmessage
}
}, "enable": "null", Starts the responder process {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPSLA - Delete
Delete operation of resource: ipsla
Successful operation
Internal Error
Response Content-Types: application/json
IPSLA - Retrieve
Retrieve operation of resource: ipsla
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
}, {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create MPLSLM instance with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create MPLSLM instance with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create MPLSLM instance with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create MPLSLM instance with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create MPLSLM instance with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create MPLSLM instance with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this MPLSLM instance
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this MPLSLM instance "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
},
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this MPLSLM instance "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this MPLSLM instance
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "mask": "string", IP netmask for target
"address": "string" No description
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create MPLSLM instance with specified type
"tag": "string", Add a tag for this MPLSLM instance
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this MPLSLM instance
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" No description
}
}, "mask": "string", IP netmask for target
"address": "string" No description
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this MPLSLM instance
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
"recurring": "null", probe to be scheduled automatically every day "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}, { "create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}, "create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, { "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
},
"create": "null", Create MPLSLM instance with specified type
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
}, "frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"type": "string" Configure IPSLA Responder port type
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
},
"create": "null", Create MPLSLM instance with specified type "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
},
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, {
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}
}, "low-memory": "integer", Configure low memory water mark (default 20M)
range: "0..4294967295"
default: 20M)" "key-chain": "string" Use MD5 authentication for IPSLA control\nmessage
}
}, "enable": "null", Starts the responder process {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}
}
}
}
COMMON - Update
Update operation of resource: common
commonbody object
Request Content-Types: application/json
Request Example
{ "low-memory": "integer", Configure low memory water mark (default 20M)
range: "0..4294967295"
default: 20M)" "key-chain": "string" Use MD5 authentication for IPSLA control\nmessage
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
COMMON - Create
Create operation of resource: common
commonbody object
Request Content-Types: application/json
Request Example
{ "low-memory": "integer", Configure low memory water mark (default 20M)
range: "0..4294967295"
default: 20M)" "key-chain": "string" Use MD5 authentication for IPSLA control\nmessage
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
COMMON - Delete
Delete operation of resource: common
Successful operation
Internal Error
Response Content-Types: application/json
COMMON - Retrieve
Retrieve operation of resource: common
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "low-memory": "integer", Configure low memory water mark (default 20M)
range: "0..4294967295"
default: 20M)" "key-chain": "string" Use MD5 authentication for IPSLA control\nmessage
}
}
}
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
Successful operation
Internal Error
MPLS-LSP-MONITOR - Update
Update operation of resource: mpls-lsp-monitor
mpls-lsp-monitorbody object
Request Content-Types: application/json
Request Example
{ { "create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}, "create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, { "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
},
"create": "null", Create MPLSLM instance with specified type
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
}, "frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"type": "string" Condition type of path failure
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
},
"create": "null", Create MPLSLM instance with specified type "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
},
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, {
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-MONITOR - Create
Create operation of resource: mpls-lsp-monitor
mpls-lsp-monitorbody object
Request Content-Types: application/json
Request Example
{ { "create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}, "create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, { "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
},
"create": "null", Create MPLSLM instance with specified type
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
}, "frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"type": "string" Condition type of path failure
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
},
"create": "null", Create MPLSLM instance with specified type "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
},
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, {
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-MONITOR - Delete
Delete operation of resource: mpls-lsp-monitor
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-MONITOR - Retrieve
Retrieve operation of resource: mpls-lsp-monitor
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}, "create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create MPLSLM instance with specified type "logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, { "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
},
"create": "null", Create MPLSLM instance with specified type
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
}, "frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
"type": "string" Condition type of path failure
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
},
"create": "null", Create MPLSLM instance with specified type "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
},
"create": "null", Create MPLSLM instance with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, {
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}
}
}
REACTIONS - Update
Update operation of resource: reactions
reactionsbody object
Request Content-Types: application/json
Request Example
{ { "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, : {React on destination to source jitter\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on round trip time threshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on source to destination packet loss\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on average source to destination\njitter threshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on destination to source packet loss\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on average round trip jitter threshold\nviolation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on error verfication violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTIONS - Create
Create operation of resource: reactions
reactionsbody object
Request Content-Types: application/json
Request Example
{ { "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, : {React on destination to source jitter\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on round trip time threshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on source to destination packet loss\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on average source to destination\njitter threshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on destination to source packet loss\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on average round trip jitter threshold\nviolation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on error verfication violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTIONS - Delete
Delete operation of resource: reactions
Successful operation
Internal Error
Response Content-Types: application/json
REACTIONS - Retrieve
Retrieve operation of resource: reactions
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, : {React on destination to source jitter\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on round trip time threshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on source to destination packet loss\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on average source to destination\njitter threshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on destination to source packet loss\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on average round trip jitter threshold\nviolation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on error verfication violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
REACTION - Update
Update operation of resource: reaction
reactionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ { "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, : {React on destination to source jitter\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on round trip time threshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on source to destination packet loss\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on average source to destination\njitter threshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on destination to source packet loss\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on average round trip jitter threshold\nviolation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on error verfication violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTION - Create
Create operation of resource: reaction
reactionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ { "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, : {React on destination to source jitter\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on round trip time threshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on source to destination packet loss\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on average source to destination\njitter threshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on destination to source packet loss\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on average round trip jitter threshold\nviolation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on error verfication violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTION - Delete
Delete operation of resource: reaction
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
REACTION - Retrieve
Retrieve operation of resource: reaction
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, : {React on destination to source jitter\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on round trip time threshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on source to destination packet loss\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on average source to destination\njitter threshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on destination to source packet loss\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on average round trip jitter threshold\nviolation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on error verfication violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
CONDITION - Update
Update operation of resource: condition
conditionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, : {React on destination to source jitter\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on round trip time threshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on source to destination packet loss\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on average source to destination\njitter threshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on destination to source packet loss\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on average round trip jitter threshold\nviolation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on error verfication violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONDITION - Create
Create operation of resource: condition
conditionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, : {React on destination to source jitter\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on round trip time threshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on source to destination packet loss\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on average source to destination\njitter threshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on destination to source packet loss\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on average round trip jitter threshold\nviolation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on error verfication violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONDITION - Delete
Delete operation of resource: condition
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
CONDITION - Retrieve
Retrieve operation of resource: condition
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, : {React on destination to source jitter\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on round trip time threshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on source to destination packet loss\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on average source to destination\njitter threshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on destination to source packet loss\nthreshold violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on average round trip jitter threshold\nviolation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, : {Specify threshold limits for the monitored\nelement "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, : {React on error verfication violation : {Type of thresholding to perform on the monitored\nelement "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation : {Type of action to be taken on threshold\nviolation(s) "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
}
LPD-TREE-TRACE - Update
Update operation of resource: lpd-tree-trace
lpd-tree-tracebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "create": "null", Create reaction condition for a particular\nMPLSLM "logging": "null" Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LPD-TREE-TRACE - Create
Create operation of resource: lpd-tree-trace
lpd-tree-tracebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "create": "null", Create reaction condition for a particular\nMPLSLM "logging": "null" Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LPD-TREE-TRACE - Delete
Delete operation of resource: lpd-tree-trace
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
LPD-TREE-TRACE - Retrieve
Retrieve operation of resource: lpd-tree-trace
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "create": "null", Create reaction condition for a particular\nMPLSLM "logging": "null" Generate a syslog alarm on threshold violation
}
}
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
TIMEOUT - Update
Update operation of resource: timeout
timeoutbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUT - Create
Create operation of resource: timeout
timeoutbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUT - Delete
Delete operation of resource: timeout
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUT - Retrieve
Retrieve operation of resource: timeout
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
LPD-GROUP - Update
Update operation of resource: lpd-group
lpd-groupbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "create": "null", Create reaction condition for a particular\nMPLSLM "logging": "null" Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LPD-GROUP - Create
Create operation of resource: lpd-group
lpd-groupbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "create": "null", Create reaction condition for a particular\nMPLSLM "logging": "null" Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LPD-GROUP - Delete
Delete operation of resource: lpd-group
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
LPD-GROUP - Retrieve
Retrieve operation of resource: lpd-group
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "create": "null", Create reaction condition for a particular\nMPLSLM "logging": "null" Generate a syslog alarm on threshold violation
}
}
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
CONNECTION-LOSS - Update
Update operation of resource: connection-loss
connection-lossbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTION-LOSS - Create
Create operation of resource: connection-loss
connection-lossbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTION-LOSS - Delete
Delete operation of resource: connection-loss
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTION-LOSS - Retrieve
Retrieve operation of resource: connection-loss
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
SCHEDULES - Update
Update operation of resource: schedules
schedulesbody object
Request Content-Types: application/json
Request Example
{ {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
"recurring": "null", probe to be scheduled automatically every day "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULES - Create
Create operation of resource: schedules
schedulesbody object
Request Content-Types: application/json
Request Example
{ {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
"recurring": "null", probe to be scheduled automatically every day "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULES - Delete
Delete operation of resource: schedules
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULES - Retrieve
Retrieve operation of resource: schedules
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
"recurring": "null", probe to be scheduled automatically every day "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
SCHEDULE - Update
Update operation of resource: schedule
schedulebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
"recurring": "null", probe to be scheduled automatically every day "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULE - Create
Create operation of resource: schedule
schedulebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
"recurring": "null", probe to be scheduled automatically every day "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULE - Delete
Delete operation of resource: schedule
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULE - Retrieve
Retrieve operation of resource: schedule
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
"recurring": "null", probe to be scheduled automatically every day "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
START-TIME - Update
Update operation of resource: start-time
start-timebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
START-TIME - Create
Create operation of resource: start-time
start-timebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
START-TIME - Delete
Delete operation of resource: start-time
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
START-TIME - Retrieve
Retrieve operation of resource: start-time
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
}
}
DEFINITIONS - Update
Update operation of resource: definitions
definitionsbody object
Request Content-Types: application/json
Request Example
{ { : {UDPEcho Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, : {ICMPPathJitter Operation type "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation : {Probe packet stream configuration\nparameters "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" : {Loose source routing path (up to 8 intermediate\nnodes) "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, : {UDPJitter Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation : {Probe packet stream configuration\nparameters "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, : {ICMPEcho Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, : {ICMPPathEcho Operation type : {Statistics collection aggregated over an hour "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device : {Loose source routing path (up to 8 intermediate\nnodes) "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Pseudowire target : {Target address "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITIONS - Create
Create operation of resource: definitions
definitionsbody object
Request Content-Types: application/json
Request Example
{ { : {UDPEcho Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, : {ICMPPathJitter Operation type "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation : {Probe packet stream configuration\nparameters "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" : {Loose source routing path (up to 8 intermediate\nnodes) "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, : {UDPJitter Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation : {Probe packet stream configuration\nparameters "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, : {ICMPEcho Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, : {ICMPPathEcho Operation type : {Statistics collection aggregated over an hour "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device : {Loose source routing path (up to 8 intermediate\nnodes) "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Pseudowire target : {Target address "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITIONS - Delete
Delete operation of resource: definitions
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITIONS - Retrieve
Retrieve operation of resource: definitions
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { : {UDPEcho Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, : {ICMPPathJitter Operation type "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation : {Probe packet stream configuration\nparameters "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" : {Loose source routing path (up to 8 intermediate\nnodes) "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, : {UDPJitter Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation : {Probe packet stream configuration\nparameters "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, : {ICMPEcho Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, : {ICMPPathEcho Operation type : {Statistics collection aggregated over an hour "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device : {Loose source routing path (up to 8 intermediate\nnodes) "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Pseudowire target : {Target address "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
DEFINITION - Update
Update operation of resource: definition
definitionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ { : {UDPEcho Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, : {ICMPPathJitter Operation type "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation : {Probe packet stream configuration\nparameters "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" : {Loose source routing path (up to 8 intermediate\nnodes) "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, : {UDPJitter Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation : {Probe packet stream configuration\nparameters "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, : {ICMPEcho Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, : {ICMPPathEcho Operation type : {Statistics collection aggregated over an hour "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device : {Loose source routing path (up to 8 intermediate\nnodes) "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Pseudowire target : {Target address "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITION - Create
Create operation of resource: definition
definitionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ { : {UDPEcho Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, : {ICMPPathJitter Operation type "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation : {Probe packet stream configuration\nparameters "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" : {Loose source routing path (up to 8 intermediate\nnodes) "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, : {UDPJitter Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation : {Probe packet stream configuration\nparameters "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, : {ICMPEcho Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, : {ICMPPathEcho Operation type : {Statistics collection aggregated over an hour "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device : {Loose source routing path (up to 8 intermediate\nnodes) "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Pseudowire target : {Target address "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITION - Delete
Delete operation of resource: definition
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITION - Retrieve
Retrieve operation of resource: definition
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { : {UDPEcho Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, : {ICMPPathJitter Operation type "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation : {Probe packet stream configuration\nparameters "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" : {Loose source routing path (up to 8 intermediate\nnodes) "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, : {UDPJitter Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation : {Probe packet stream configuration\nparameters "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, : {ICMPEcho Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, : {ICMPPathEcho Operation type : {Statistics collection aggregated over an hour "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device : {Loose source routing path (up to 8 intermediate\nnodes) "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Pseudowire target : {Target address "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
OPERATION-TYPE - Update
Update operation of resource: operation-type
operation-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ : {UDPEcho Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, : {ICMPPathJitter Operation type "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation : {Probe packet stream configuration\nparameters "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" : {Loose source routing path (up to 8 intermediate\nnodes) "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, : {UDPJitter Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation : {Probe packet stream configuration\nparameters "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, : {ICMPEcho Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, : {ICMPPathEcho Operation type : {Statistics collection aggregated over an hour "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device : {Loose source routing path (up to 8 intermediate\nnodes) "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Pseudowire target : {Target address "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION-TYPE - Create
Create operation of resource: operation-type
operation-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ : {UDPEcho Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, : {ICMPPathJitter Operation type "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation : {Probe packet stream configuration\nparameters "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" : {Loose source routing path (up to 8 intermediate\nnodes) "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, : {UDPJitter Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation : {Probe packet stream configuration\nparameters "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, : {ICMPEcho Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, : {ICMPPathEcho Operation type : {Statistics collection aggregated over an hour "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device : {Loose source routing path (up to 8 intermediate\nnodes) "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Pseudowire target : {Target address "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION-TYPE - Delete
Delete operation of resource: operation-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION-TYPE - Retrieve
Retrieve operation of resource: operation-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {UDPEcho Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, : {ICMPPathJitter Operation type "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation : {Probe packet stream configuration\nparameters "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" : {Loose source routing path (up to 8 intermediate\nnodes) "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, : {UDPJitter Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation : {Probe packet stream configuration\nparameters "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, : {ICMPEcho Operation type : {Statistics collection aggregated over an hour "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, : {ICMPPathEcho Operation type : {Statistics collection aggregated over an hour "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type : {Protocol data size in payload of probe\npackets "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device : {Loose source routing path (up to 8 intermediate\nnodes) "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Pseudowire target : {Target address "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
}
}
MPLS-LSP-TRACE - Update
Update operation of resource: mpls-lsp-trace
mpls-lsp-tracebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-TRACE - Create
Create operation of resource: mpls-lsp-trace
mpls-lsp-tracebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-TRACE - Delete
Delete operation of resource: mpls-lsp-trace
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-TRACE - Retrieve
Retrieve operation of resource: mpls-lsp-trace
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
}
REPLY - Update
Update operation of resource: reply
replybody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Create
Create operation of resource: reply
replybody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Delete
Delete operation of resource: reply
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Retrieve
Retrieve operation of resource: reply
ID of monitor-id
Successful operation
Internal Error
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
SCAN - Update
Update operation of resource: scan
scanbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCAN - Create
Create operation of resource: scan
scanbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCAN - Delete
Delete operation of resource: scan
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
SCAN - Retrieve
Retrieve operation of resource: scan
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
}
MPLS-LSP-PING - Update
Update operation of resource: mpls-lsp-ping
mpls-lsp-pingbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Pseudowire target : {Target address "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-PING - Create
Create operation of resource: mpls-lsp-ping
mpls-lsp-pingbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Pseudowire target : {Target address "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-PING - Delete
Delete operation of resource: mpls-lsp-ping
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-PING - Retrieve
Retrieve operation of resource: mpls-lsp-ping
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {Table of statistics collection intervals : [No description {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, : {Target for the MPLS LSP operation : {Pseudowire target : {Target address "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, : {Target specified as an IPv4 address : {Target FEC address with mask "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, : {Traffic engineering target "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" : {Configure the history parameters for this\noperation "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
}
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of monitor-id
Successful operation
Internal Error
PATH-DISCOVER - Update
Update operation of resource: path-discover
path-discoverbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
default: "60"
"type": "string" Condition type of path failure
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
},
"create": "null", Create LPD instance "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Timeout value for echo requests during\npath discovery
range: "1..600000"
units: "millisecond"
default: "5000"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
"timeout": "integer", Timeout value for echo requests during\npath discovery
range: "1..600000"
units: "millisecond"
default: "5000"
"interval": "integer" Send interval between echo requests\nduring path discovery
units: "minute"
default: "240"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PATH-DISCOVER - Create
Create operation of resource: path-discover
path-discoverbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
default: "60"
"type": "string" Condition type of path failure
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
},
"create": "null", Create LPD instance "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Timeout value for echo requests during\npath discovery
range: "1..600000"
units: "millisecond"
default: "5000"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
"timeout": "integer", Timeout value for echo requests during\npath discovery
range: "1..600000"
units: "millisecond"
default: "5000"
"interval": "integer" Send interval between echo requests\nduring path discovery
units: "minute"
default: "240"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PATH-DISCOVER - Delete
Delete operation of resource: path-discover
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
PATH-DISCOVER - Retrieve
Retrieve operation of resource: path-discover
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
default: "60"
"type": "string" Condition type of path failure
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
},
"create": "null", Create LPD instance "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Timeout value for echo requests during\npath discovery
range: "1..600000"
units: "millisecond"
default: "5000"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
"timeout": "integer", Timeout value for echo requests during\npath discovery
range: "1..600000"
units: "millisecond"
default: "5000"
"interval": "integer" Send interval between echo requests\nduring path discovery
units: "minute"
default: "240"
}
}
}
SESSION - Update
Update operation of resource: session
sessionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Timeout value for path discovery request
range: "1..600000"
units: "millisecond"
default: "5000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Create
Create operation of resource: session
sessionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Timeout value for path discovery request
range: "1..600000"
units: "millisecond"
default: "5000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Delete
Delete operation of resource: session
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Retrieve
Retrieve operation of resource: session
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Timeout value for path discovery request
range: "1..600000"
units: "millisecond"
default: "5000"
}
}
PATH - Update
Update operation of resource: path
pathbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
default: "60"
"type": "string" Condition type of path failure
},
"retry": "integer" Number of attempts before declaring the\npath as down
range: "0..100"
default: "1"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PATH - Create
Create operation of resource: path
pathbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
default: "60"
"type": "string" Condition type of path failure
},
"retry": "integer" Number of attempts before declaring the\npath as down
range: "0..100"
default: "1"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PATH - Delete
Delete operation of resource: path
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
PATH - Retrieve
Retrieve operation of resource: path
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
default: "60"
"type": "string" Condition type of path failure
},
"retry": "integer" Number of attempts before declaring the\npath as down
range: "0..100"
default: "1"
}
}
SECONDARY-FREQUENCY - Update
Update operation of resource: secondary-frequency
secondary-frequencybody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-FREQUENCY - Create
Create operation of resource: secondary-frequency
secondary-frequencybody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-FREQUENCY - Delete
Delete operation of resource: secondary-frequency
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-FREQUENCY - Retrieve
Retrieve operation of resource: secondary-frequency
ID of monitor-id
Successful operation
Internal Error
ECHO - Update
Update operation of resource: echo
echobody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
"timeout": "integer", Timeout value for echo requests during\npath discovery
range: "1..600000"
units: "millisecond"
default: "5000"
"interval": "integer" Send interval between echo requests\nduring path discovery
units: "minute"
default: "240"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ECHO - Create
Create operation of resource: echo
echobody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
"timeout": "integer", Timeout value for echo requests during\npath discovery
range: "1..600000"
units: "millisecond"
default: "5000"
"interval": "integer" Send interval between echo requests\nduring path discovery
units: "minute"
default: "240"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ECHO - Delete
Delete operation of resource: echo
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ECHO - Retrieve
Retrieve operation of resource: echo
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"
"timeout": "integer", Timeout value for echo requests during\npath discovery
range: "1..600000"
units: "millisecond"
default: "5000"
"interval": "integer" Send interval between echo requests\nduring path discovery
units: "minute"
default: "240"
}
}
MULTIPATH - Update
Update operation of resource: multipath
multipathbody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
MULTIPATH - Create
Create operation of resource: multipath
multipathbody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
MULTIPATH - Delete
Delete operation of resource: multipath
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
MULTIPATH - Retrieve
Retrieve operation of resource: multipath
ID of monitor-id
Successful operation
Internal Error
REPLY - Update
Update operation of resource: reply
replybody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Create
Create operation of resource: reply
replybody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Delete
Delete operation of resource: reply
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Retrieve
Retrieve operation of resource: reply
ID of monitor-id
Successful operation
Internal Error
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
SCAN - Update
Update operation of resource: scan
scanbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCAN - Create
Create operation of resource: scan
scanbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCAN - Delete
Delete operation of resource: scan
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
SCAN - Retrieve
Retrieve operation of resource: scan
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"
}
}
OPERATION - Update
Update operation of resource: operation
operationbody object
Request Content-Types: application/json
Request Example
{ {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create operation with specified type "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create operation with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create operation with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create operation with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create operation with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create operation with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create operation with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create operation with specified type "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create operation with specified type "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
"recurring": "null", probe to be scheduled automatically every day "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION - Create
Create operation of resource: operation
operationbody object
Request Content-Types: application/json
Request Example
{ {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create operation with specified type "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create operation with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create operation with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create operation with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create operation with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create operation with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create operation with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create operation with specified type "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create operation with specified type "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
"recurring": "null", probe to be scheduled automatically every day "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION - Delete
Delete operation of resource: operation
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION - Retrieve
Retrieve operation of resource: operation
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create operation with specified type "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create operation with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create operation with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create operation with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create operation with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create operation with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create operation with specified type
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create operation with specified type "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create operation with specified type "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
"recurring": "null", probe to be scheduled automatically every day "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
}
SCHEDULES - Update
Update operation of resource: schedules
schedulesbody object
Request Content-Types: application/json
Request Example
{ {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
"recurring": "null", probe to be scheduled automatically every day "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULES - Create
Create operation of resource: schedules
schedulesbody object
Request Content-Types: application/json
Request Example
{ {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
"recurring": "null", probe to be scheduled automatically every day "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULES - Delete
Delete operation of resource: schedules
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULES - Retrieve
Retrieve operation of resource: schedules
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
"recurring": "null", probe to be scheduled automatically every day "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
SCHEDULE - Update
Update operation of resource: schedule
schedulebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
"recurring": "null", probe to be scheduled automatically every day "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULE - Create
Create operation of resource: schedule
schedulebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
"recurring": "null", probe to be scheduled automatically every day "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULE - Delete
Delete operation of resource: schedule
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULE - Retrieve
Retrieve operation of resource: schedule
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
"recurring": "null", probe to be scheduled automatically every day "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
START-TIME - Update
Update operation of resource: start-time
start-timebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
START-TIME - Create
Create operation of resource: start-time
start-timebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
START-TIME - Delete
Delete operation of resource: start-time
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
START-TIME - Retrieve
Retrieve operation of resource: start-time
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "string", Month of the year (optional. Default current\nmonth)
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "string", Type of schedule
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
}
}
REACTIONS - Update
Update operation of resource: reactions
reactionsbody object
Request Content-Types: application/json
Request Example
{ { "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTIONS - Create
Create operation of resource: reactions
reactionsbody object
Request Content-Types: application/json
Request Example
{ { "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTIONS - Delete
Delete operation of resource: reactions
Successful operation
Internal Error
Response Content-Types: application/json
REACTIONS - Retrieve
Retrieve operation of resource: reactions
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
REACTION - Update
Update operation of resource: reaction
reactionbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ { "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTION - Create
Create operation of resource: reaction
reactionbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ { "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTION - Delete
Delete operation of resource: reaction
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REACTION - Retrieve
Retrieve operation of resource: reaction
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
CONDITION - Update
Update operation of resource: condition
conditionbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONDITION - Create
Create operation of resource: condition
conditionbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONDITION - Delete
Delete operation of resource: condition
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
CONDITION - Retrieve
Retrieve operation of resource: condition
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}, "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
}
JITTER-AVERAGE-DS - Update
Update operation of resource: jitter-average-ds
jitter-average-dsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE-DS - Create
Create operation of resource: jitter-average-ds
jitter-average-dsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE-DS - Delete
Delete operation of resource: jitter-average-ds
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE-DS - Retrieve
Retrieve operation of resource: jitter-average-ds
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}
}
THRESHOLD-LIMITS - Update
Update operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Create
Create operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Delete
Delete operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Retrieve
Retrieve operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
TIMEOUT - Update
Update operation of resource: timeout
timeoutbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUT - Create
Create operation of resource: timeout
timeoutbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUT - Delete
Delete operation of resource: timeout
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUT - Retrieve
Retrieve operation of resource: timeout
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
JITTER-AVERAGE - Update
Update operation of resource: jitter-average
jitter-averagebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE - Create
Create operation of resource: jitter-average
jitter-averagebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE - Delete
Delete operation of resource: jitter-average
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE - Retrieve
Retrieve operation of resource: jitter-average
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}
}
THRESHOLD-LIMITS - Update
Update operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Create
Create operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Delete
Delete operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Retrieve
Retrieve operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
VERIFY-ERROR - Update
Update operation of resource: verify-error
verify-errorbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VERIFY-ERROR - Create
Create operation of resource: verify-error
verify-errorbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VERIFY-ERROR - Delete
Delete operation of resource: verify-error
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
VERIFY-ERROR - Retrieve
Retrieve operation of resource: verify-error
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
RTT - Update
Update operation of resource: rtt
rttbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RTT - Create
Create operation of resource: rtt
rttbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RTT - Delete
Delete operation of resource: rtt
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
RTT - Retrieve
Retrieve operation of resource: rtt
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}
}
THRESHOLD-LIMITS - Update
Update operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Create
Create operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Delete
Delete operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Retrieve
Retrieve operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
PACKET-LOSS-SD - Update
Update operation of resource: packet-loss-sd
packet-loss-sdbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET-LOSS-SD - Create
Create operation of resource: packet-loss-sd
packet-loss-sdbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET-LOSS-SD - Delete
Delete operation of resource: packet-loss-sd
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PACKET-LOSS-SD - Retrieve
Retrieve operation of resource: packet-loss-sd
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}
}
THRESHOLD-LIMITS - Update
Update operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Create
Create operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Delete
Delete operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Retrieve
Retrieve operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
JITTER-AVERAGE-SD - Update
Update operation of resource: jitter-average-sd
jitter-average-sdbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE-SD - Create
Create operation of resource: jitter-average-sd
jitter-average-sdbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE-SD - Delete
Delete operation of resource: jitter-average-sd
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE-SD - Retrieve
Retrieve operation of resource: jitter-average-sd
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}
}
THRESHOLD-LIMITS - Update
Update operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Create
Create operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Delete
Delete operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Retrieve
Retrieve operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
CONNECTION-LOSS - Update
Update operation of resource: connection-loss
connection-lossbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTION-LOSS - Create
Create operation of resource: connection-loss
connection-lossbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTION-LOSS - Delete
Delete operation of resource: connection-loss
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTION-LOSS - Retrieve
Retrieve operation of resource: connection-loss
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
},
"create": "null", Create reaction condition for a particular\noperation "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
}
}
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
PACKET-LOSS-DS - Update
Update operation of resource: packet-loss-ds
packet-loss-dsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET-LOSS-DS - Create
Create operation of resource: packet-loss-ds
packet-loss-dsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET-LOSS-DS - Delete
Delete operation of resource: packet-loss-ds
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PACKET-LOSS-DS - Retrieve
Retrieve operation of resource: packet-loss-ds
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": "null", Generate trigger to active reaction triggered\noperation(s)
"logging": "null" Generate a syslog alarm on threshold violation
},
"create": "null" Create reaction condition for a particular\noperation
}
}
THRESHOLD-LIMITS - Update
Update operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Create
Create operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Delete
Delete operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Retrieve
Retrieve operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string", Type of thresholding to perform
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"
}
}
REACTION-TRIGGERS - Update
Update operation of resource: reaction-triggers
reaction-triggersbody object
Request Content-Types: application/json
Request Example
{ {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number of the operation generating\na trigger
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTION-TRIGGERS - Create
Create operation of resource: reaction-triggers
reaction-triggersbody object
Request Content-Types: application/json
Request Example
{ {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number of the operation generating\na trigger
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTION-TRIGGERS - Delete
Delete operation of resource: reaction-triggers
Successful operation
Internal Error
Response Content-Types: application/json
REACTION-TRIGGERS - Retrieve
Retrieve operation of resource: reaction-triggers
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number of the operation generating\na trigger
range: "1..2048"
}
]
}
}
REACTION-TRIGGER - Update
Update operation of resource: reaction-trigger
reaction-triggerbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REACTION-TRIGGER - Create
Create operation of resource: reaction-trigger
reaction-triggerbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REACTION-TRIGGER - Delete
Delete operation of resource: reaction-trigger
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REACTION-TRIGGER - Retrieve
Retrieve operation of resource: reaction-trigger
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number of the operation generating\na trigger
range: "1..2048"
}
]
}
DEFINITIONS - Update
Update operation of resource: definitions
definitionsbody object
Request Content-Types: application/json
Request Example
{ { "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITIONS - Create
Create operation of resource: definitions
definitionsbody object
Request Content-Types: application/json
Request Example
{ { "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITIONS - Delete
Delete operation of resource: definitions
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITIONS - Retrieve
Retrieve operation of resource: definitions
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
DEFINITION - Update
Update operation of resource: definition
definitionbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ { "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITION - Create
Create operation of resource: definition
definitionbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ { "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITION - Delete
Delete operation of resource: definition
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITION - Retrieve
Retrieve operation of resource: definition
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
OPERATION-TYPE - Update
Update operation of resource: operation-type
operation-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION-TYPE - Create
Create operation of resource: operation-type
operation-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION-TYPE - Delete
Delete operation of resource: operation-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION-TYPE - Retrieve
Retrieve operation of resource: operation-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}, "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in history\nbuffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}, {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
}
}
ICMP-ECHO - Update
Update operation of resource: icmp-echo
icmp-echobody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-ECHO - Create
Create operation of resource: icmp-echo
icmp-echobody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-ECHO - Delete
Delete operation of resource: icmp-echo
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-ECHO - Retrieve
Retrieve operation of resource: icmp-echo
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}
}
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
HISTORY - Update
Update operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in\nhistory buffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Create
Create operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in\nhistory buffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Delete
Delete operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Retrieve
Retrieve operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in\nhistory buffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
ENHANCED-STATS - Update
Update operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Create
Create operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Delete
Delete operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Retrieve
Retrieve operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}
}
ENHANCED-STAT - Update
Update operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Create
Create operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Delete
Delete operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Retrieve
Retrieve operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
MPLS-LSP-PING - Update
Update operation of resource: mpls-lsp-ping
mpls-lsp-pingbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-PING - Create
Create operation of resource: mpls-lsp-ping
mpls-lsp-pingbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-PING - Delete
Delete operation of resource: mpls-lsp-ping
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-PING - Retrieve
Retrieve operation of resource: mpls-lsp-ping
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
}
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
REPLY - Update
Update operation of resource: reply
replybody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Create
Create operation of resource: reply
replybody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Delete
Delete operation of resource: reply
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Retrieve
Retrieve operation of resource: reply
ID of operation-id
Successful operation
Internal Error
TARGET - Update
Update operation of resource: target
targetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
}
}
TRAFFIC-ENGINEERING - Update
Update operation of resource: traffic-engineering
traffic-engineeringbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Create
Create operation of resource: traffic-engineering
traffic-engineeringbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Delete
Delete operation of resource: traffic-engineering
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Retrieve
Retrieve operation of resource: traffic-engineering
ID of operation-id
Successful operation
Internal Error
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
ID of operation-id
Successful operation
Internal Error
FEC-ADDRESS - Update
Update operation of resource: fec-address
fec-addressbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
FEC-ADDRESS - Create
Create operation of resource: fec-address
fec-addressbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
FEC-ADDRESS - Delete
Delete operation of resource: fec-address
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
FEC-ADDRESS - Retrieve
Retrieve operation of resource: fec-address
ID of operation-id
Successful operation
Internal Error
PSEUDOWIRE - Update
Update operation of resource: pseudowire
pseudowirebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE - Create
Create operation of resource: pseudowire
pseudowirebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE - Delete
Delete operation of resource: pseudowire
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE - Retrieve
Retrieve operation of resource: pseudowire
ID of operation-id
Successful operation
Internal Error
TARGET-ADDRESS - Update
Update operation of resource: target-address
target-addressbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Create
Create operation of resource: target-address
target-addressbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Delete
Delete operation of resource: target-address
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
ID of operation-id
Successful operation
Internal Error
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
HISTORY - Update
Update operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in\nhistory buffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Create
Create operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in\nhistory buffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Delete
Delete operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Retrieve
Retrieve operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in\nhistory buffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
ENHANCED-STATS - Update
Update operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Create
Create operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Delete
Delete operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Retrieve
Retrieve operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}
}
ENHANCED-STAT - Update
Update operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Create
Create operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Delete
Delete operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Retrieve
Retrieve operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
UDP-ECHO - Update
Update operation of resource: udp-echo
udp-echobody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
UDP-ECHO - Create
Create operation of resource: udp-echo
udp-echobody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
UDP-ECHO - Delete
Delete operation of resource: udp-echo
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
UDP-ECHO - Retrieve
Retrieve operation of resource: udp-echo
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
}
}
}
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
HISTORY - Update
Update operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in\nhistory buffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Create
Create operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in\nhistory buffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Delete
Delete operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Retrieve
Retrieve operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in\nhistory buffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
ENHANCED-STATS - Update
Update operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Create
Create operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Delete
Delete operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Retrieve
Retrieve operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}
}
ENHANCED-STAT - Update
Update operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Create
Create operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Delete
Delete operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Retrieve
Retrieve operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
MPLS-LSP-TRACE - Update
Update operation of resource: mpls-lsp-trace
mpls-lsp-tracebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-TRACE - Create
Create operation of resource: mpls-lsp-trace
mpls-lsp-tracebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-TRACE - Delete
Delete operation of resource: mpls-lsp-trace
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-TRACE - Retrieve
Retrieve operation of resource: mpls-lsp-trace
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device
"create": "null", Create operation with specified type
"tag": "string", Add a tag for this operation
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "string", Enables use of router alert in echo reply\npackets
"dscp-bits": "string" DSCP bits in the reply IP header
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string" Choose type of data to be stored in history\nbuffer
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null": "null" Forced option for the MPLS LSP operation
}
}
TARGET - Update
Update operation of resource: target
targetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
}
}
TRAFFIC-ENGINEERING - Update
Update operation of resource: traffic-engineering
traffic-engineeringbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Create
Create operation of resource: traffic-engineering
traffic-engineeringbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Delete
Delete operation of resource: traffic-engineering
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Retrieve
Retrieve operation of resource: traffic-engineering
ID of operation-id
Successful operation
Internal Error
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
ID of operation-id
Successful operation
Internal Error
FEC-ADDRESS - Update
Update operation of resource: fec-address
fec-addressbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
FEC-ADDRESS - Create
Create operation of resource: fec-address
fec-addressbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
FEC-ADDRESS - Delete
Delete operation of resource: fec-address
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
FEC-ADDRESS - Retrieve
Retrieve operation of resource: fec-address
ID of operation-id
Successful operation
Internal Error
REPLY - Update
Update operation of resource: reply
replybody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Create
Create operation of resource: reply
replybody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Delete
Delete operation of resource: reply
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Retrieve
Retrieve operation of resource: reply
ID of operation-id
Successful operation
Internal Error
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
HISTORY - Update
Update operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in\nhistory buffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Create
Create operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in\nhistory buffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Delete
Delete operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Retrieve
Retrieve operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in\nhistory buffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
UDP-JITTER - Update
Update operation of resource: udp-jitter
udp-jitterbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}
}
Successful operation
Internal Error
Response Content-Types: application/json
UDP-JITTER - Create
Create operation of resource: udp-jitter
udp-jitterbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}
}
Successful operation
Internal Error
Response Content-Types: application/json
UDP-JITTER - Delete
Delete operation of resource: udp-jitter
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
UDP-JITTER - Retrieve
Retrieve operation of resource: udp-jitter
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": "null", Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
},
"control-disable": "null", Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
},
"dest-port": "string" Port number on target device
}
}
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
PACKET - Update
Update operation of resource: packet
packetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Packet interval in milliseconds
units: "minute"
default: "240"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET - Create
Create operation of resource: packet
packetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Packet interval in milliseconds
units: "minute"
default: "240"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET - Delete
Delete operation of resource: packet
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PACKET - Retrieve
Retrieve operation of resource: packet
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Packet interval in milliseconds
units: "minute"
default: "240"
}
}
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
ENHANCED-STATS - Update
Update operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Create
Create operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Delete
Delete operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Retrieve
Retrieve operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"
"interval": "integer" Interval in seconds
units: "minute"
default: "240"
}
]
}
}
ENHANCED-STAT - Update
Update operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Create
Create operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Delete
Delete operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Retrieve
Retrieve operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
ICMP-PATH-ECHO - Update
Update operation of resource: icmp-path-echo
icmp-path-echobody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in\nhistory buffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-PATH-ECHO - Create
Create operation of resource: icmp-path-echo
icmp-path-echobody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in\nhistory buffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-PATH-ECHO - Delete
Delete operation of resource: icmp-path-echo
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-PATH-ECHO - Retrieve
Retrieve operation of resource: icmp-path-echo
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in\nhistory buffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
}
HISTORY - Update
Update operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in\nhistory buffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Create
Create operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in\nhistory buffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Delete
Delete operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Retrieve
Retrieve operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "string", Choose type of data to be stored in\nhistory buffer
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
LSR-PATH - Update
Update operation of resource: lsr-path
lsr-pathbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LSR-PATH - Create
Create operation of resource: lsr-path
lsr-pathbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LSR-PATH - Delete
Delete operation of resource: lsr-path
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
LSR-PATH - Retrieve
Retrieve operation of resource: lsr-path
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}
}
ICMP-PATH-JITTER - Update
Update operation of resource: icmp-path-jitter
icmp-path-jitterbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Packet interval in milliseconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-PATH-JITTER - Create
Create operation of resource: icmp-path-jitter
icmp-path-jitterbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Packet interval in milliseconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-PATH-JITTER - Delete
Delete operation of resource: icmp-path-jitter
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-PATH-JITTER - Retrieve
Retrieve operation of resource: icmp-path-jitter
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"create": "null", Create operation with specified type "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Packet interval in milliseconds
units: "minute"
default: "240"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}
}
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
PACKET - Update
Update operation of resource: packet
packetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Packet interval in milliseconds
units: "minute"
default: "240"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET - Create
Create operation of resource: packet
packetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Packet interval in milliseconds
units: "minute"
default: "240"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET - Delete
Delete operation of resource: packet
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PACKET - Retrieve
Retrieve operation of resource: packet
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Packet interval in milliseconds
units: "minute"
default: "240"
}
}
LSR-PATH - Update
Update operation of resource: lsr-path
lsr-pathbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LSR-PATH - Create
Create operation of resource: lsr-path
lsr-pathbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LSR-PATH - Delete
Delete operation of resource: lsr-path
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
LSR-PATH - Retrieve
Retrieve operation of resource: lsr-path
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}
}
RESPONDER - Update
Update operation of resource: responder
responderbody object
Request Content-Types: application/json
Request Example
{ "enable": "null", Starts the responder process {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RESPONDER - Create
Create operation of resource: responder
responderbody object
Request Content-Types: application/json
Request Example
{ "enable": "null", Starts the responder process {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RESPONDER - Delete
Delete operation of resource: responder
Successful operation
Internal Error
Response Content-Types: application/json
RESPONDER - Retrieve
Retrieve operation of resource: responder
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": "null", Starts the responder process {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}
}
}
TYPE - Update
Update operation of resource: type
typebody object
Request Content-Types: application/json
Request Example
{ {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TYPE - Create
Create operation of resource: type
typebody object
Request Content-Types: application/json
Request Example
{ {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TYPE - Delete
Delete operation of resource: type
Successful operation
Internal Error
Response Content-Types: application/json
TYPE - Retrieve
Retrieve operation of resource: type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}
}
UDP - Update
Update operation of resource: udp
udpbody object
Request Content-Types: application/json
Request Example
{ {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
UDP - Create
Create operation of resource: udp
udpbody object
Request Content-Types: application/json
Request Example
{ {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
UDP - Delete
Delete operation of resource: udp
Successful operation
Internal Error
Response Content-Types: application/json
UDP - Retrieve
Retrieve operation of resource: udp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}
ADDRESSES - Update
Update operation of resource: addresses
addressesbody object
Request Content-Types: application/json
Request Example
{ {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESSES - Create
Create operation of resource: addresses
addressesbody object
Request Content-Types: application/json
Request Example
{ {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESSES - Delete
Delete operation of resource: addresses
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESSES - Retrieve
Retrieve operation of resource: addresses
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
ADDRESS - Update
Update operation of resource: address
addressbody object
ID of local-address
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESS - Create
Create operation of resource: address
addressbody object
ID of local-address
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESS - Delete
Delete operation of resource: address
ID of local-address
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESS - Retrieve
Retrieve operation of resource: address
ID of local-address
Successful operation
Internal Error
PORTS - Update
Update operation of resource: ports
portsbody object
ID of local-address
Successful operation
Internal Error
Response Content-Types: application/json
PORTS - Create
Create operation of resource: ports
portsbody object
ID of local-address
Successful operation
Internal Error
Response Content-Types: application/json
PORTS - Delete
Delete operation of resource: ports
ID of local-address
Successful operation
Internal Error
Response Content-Types: application/json
PORTS - Retrieve
Retrieve operation of resource: ports
ID of local-address
PORT - Update
Update operation of resource: port
portbody object
ID of local-address
ID of port
Successful operation
Internal Error
Response Content-Types: application/json
PORT - Create
Create operation of resource: port
portbody object
ID of local-address
ID of port
Successful operation
Internal Error
Response Content-Types: application/json
PORT - Delete
Delete operation of resource: port
ID of local-address
ID of port
Successful operation
Internal Error
Response Content-Types: application/json
PORT - Retrieve
Retrieve operation of resource: port
ID of local-address
ID of port
Successful operation
Internal Error
MPLS-DISCOVERY - Update
Update operation of resource: mpls-discovery
mpls-discoverybody object
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-DISCOVERY - Create
Create operation of resource: mpls-discovery
mpls-discoverybody object
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-DISCOVERY - Delete
Delete operation of resource: mpls-discovery
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-DISCOVERY - Retrieve
Retrieve operation of resource: mpls-discovery
Successful operation
Internal Error
VPN - Update
Update operation of resource: vpn
vpnbody object
Successful operation
Internal Error
Response Content-Types: application/json
VPN - Create
Create operation of resource: vpn
vpnbody object
Successful operation
Internal Error
Response Content-Types: application/json
VPN - Delete
Delete operation of resource: vpn
Successful operation
Internal Error
Response Content-Types: application/json
VPN - Retrieve
Retrieve operation of resource: vpn
Successful operation
Internal Error
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
ENCRYPTED-COMMUNITY-MAPS - Update
Update operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Request Content-Types: application/json
Request Example
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Create
Create operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Request Content-Types: application/json
Request Example
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Delete
Delete operation of resource: encrypted-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: encrypted-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
ENCRYPTED-COMMUNITY-MAP - Update
Update operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Create
Create operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Delete
Delete operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
VIEWS - Update
Update operation of resource: views
viewsbody object
Request Content-Types: application/json
Request Example
{ {
"view-name": "string", Name of the view
"view-inclusion": "string", MIB view to be included or excluded
"family": "string" MIB view family name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Create
Create operation of resource: views
viewsbody object
Request Content-Types: application/json
Request Example
{ {
"view-name": "string", Name of the view
"view-inclusion": "string", MIB view to be included or excluded
"family": "string" MIB view family name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Delete
Delete operation of resource: views
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Retrieve
Retrieve operation of resource: views
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"view-name": "string", Name of the view
"view-inclusion": "string", MIB view to be included or excluded
"family": "string" MIB view family name
}
]
}
}
VIEW - Update
Update operation of resource: view
viewbody object
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Create
Create operation of resource: view
viewbody object
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Delete
Delete operation of resource: view
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Retrieve
Retrieve operation of resource: view
ID of view-name family
Successful operation
Internal Error
LOGGING - Update
Update operation of resource: logging
loggingbody object
Request Content-Types: application/json
Request Example
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Create
Create operation of resource: logging
loggingbody object
Request Content-Types: application/json
Request Example
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Delete
Delete operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Retrieve
Retrieve operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
}
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
ADMINISTRATION - Update
Update operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}, {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Create
Create operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}, {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Delete
Delete operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Retrieve
Retrieve operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}, {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
}
DEFAULT-COMMUNITIES - Update
Update operation of resource: default-communities
default-communitiesbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Create
Create operation of resource: default-communities
default-communitiesbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Delete
Delete operation of resource: default-communities
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Retrieve
Retrieve operation of resource: default-communities
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
DEFAULT-COMMUNITY - Update
Update operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Create
Create operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Delete
Delete operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Retrieve
Retrieve operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
ENCRYPTED-COMMUNITIES - Update
Update operation of resource: encrypted-communities
encrypted-communitiesbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Create
Create operation of resource: encrypted-communities
encrypted-communitiesbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Delete
Delete operation of resource: encrypted-communities
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-communities
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
ENCRYPTED-COMMUNITY - Update
Update operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Create
Create operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Delete
Delete operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
AGENT - Update
Update operation of resource: agent
agentbody object
Request Content-Types: application/json
Request Example
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Create
Create operation of resource: agent
agentbody object
Request Content-Types: application/json
Request Example
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Delete
Delete operation of resource: agent
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Retrieve
Retrieve operation of resource: agent
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
}
ENGINE-ID - Update
Update operation of resource: engine-id
engine-idbody object
Request Content-Types: application/json
Request Example
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Create
Create operation of resource: engine-id
engine-idbody object
Request Content-Types: application/json
Request Example
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Delete
Delete operation of resource: engine-id
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Retrieve
Retrieve operation of resource: engine-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
REMOTES - Update
Update operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Create
Create operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Delete
Delete operation of resource: remotes
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Retrieve
Retrieve operation of resource: remotes
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
}
}
REMOTE - Update
Update operation of resource: remote
remotebody object
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Create
Create operation of resource: remote
remotebody object
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Delete
Delete operation of resource: remote
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Retrieve
Retrieve operation of resource: remote
ID of remote-address
Successful operation
Internal Error
TRAP - Update
Update operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{ "queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "millisecond"
default: "5000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Create
Create operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{ "queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "millisecond"
default: "5000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Delete
Delete operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Retrieve
Retrieve operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "millisecond"
default: "5000"
}
}
DROP-PACKET - Update
Update operation of resource: drop-packet
drop-packetbody object
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Create
Create operation of resource: drop-packet
drop-packetbody object
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Delete
Delete operation of resource: drop-packet
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Retrieve
Retrieve operation of resource: drop-packet
Successful operation
Internal Error
IPV6 - Update
Update operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Create
Create operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Delete
Delete operation of resource: ipv6
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Retrieve
Retrieve operation of resource: ipv6
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
SYSTEM - Update
Update operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{ "chassis-id": "string", String to uniquely identify this chassis
"contact": "string", identification of the contact person for this\nmanaged node
"location": "string" The physical location of this node
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Create
Create operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{ "chassis-id": "string", String to uniquely identify this chassis
"contact": "string", identification of the contact person for this\nmanaged node
"location": "string" The physical location of this node
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Delete
Delete operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Retrieve
Retrieve operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "chassis-id": "string", String to uniquely identify this chassis
"contact": "string", identification of the contact person for this\nmanaged node
"location": "string" The physical location of this node
}
}
TARGET - Update
Update operation of resource: target
targetbody object
Request Content-Types: application/json
Request Example
{ : {SNMP Target address configurations : [No description {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list : {List of VRF Name for a target list : [No description {
"name": "string" VRF Name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
Request Content-Types: application/json
Request Example
{ : {SNMP Target address configurations : [No description {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list : {List of VRF Name for a target list : [No description {
"name": "string" VRF Name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {SNMP Target address configurations : [No description {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list : {List of VRF Name for a target list : [No description {
"name": "string" VRF Name
}
]
}
}
}
TARGETS - Update
Update operation of resource: targets
targetsbody object
Request Content-Types: application/json
Request Example
{ { {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Create
Create operation of resource: targets
targetsbody object
Request Content-Types: application/json
Request Example
{ { {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Delete
Delete operation of resource: targets
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Retrieve
Retrieve operation of resource: targets
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
]
}
}
TARGET - Update
Update operation of resource: target
targetbody object
ID of target-list-name
Request Content-Types: application/json
Request Example
{ {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
ID of target-list-name
Request Content-Types: application/json
Request Example
{ {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
}
VRF-NAMES - Update
Update operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Create
Create operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Delete
Delete operation of resource: vrf-names
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Retrieve
Retrieve operation of resource: vrf-names
ID of target-list-name
VRF-NAME - Update
Update operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Create
Create operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Delete
Delete operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Retrieve
Retrieve operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
TARGET-ADDRESSES - Update
Update operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Create
Create operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Delete
Delete operation of resource: target-addresses
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Retrieve
Retrieve operation of resource: target-addresses
ID of target-list-name
TARGET-ADDRESS - Update
Update operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Create
Create operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Delete
Delete operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
NOTIFICATION - Update
Update operation of resource: notification
notificationbody object
Request Content-Types: application/json
Request Example
{ "ipsla": "boolean", Enable SNMP RTTMON-MIB IPSLA traps "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Create
Create operation of resource: notification
notificationbody object
Request Content-Types: application/json
Request Example
{ "ipsla": "boolean", Enable SNMP RTTMON-MIB IPSLA traps "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Delete
Delete operation of resource: notification
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Retrieve
Retrieve operation of resource: notification
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "ipsla": "boolean", Enable SNMP RTTMON-MIB IPSLA traps "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
}
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
CORRELATOR - Update
Update operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"name": "string" Ruleset name
}
]
}, { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
},
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Create
Create operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"name": "string" Ruleset name
}
]
}, { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
},
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Delete
Delete operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Retrieve
Retrieve operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"name": "string" Ruleset name
}
]
}, { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
},
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"
}
}
RULES - Update
Update operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"name": "string" Rule name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Create
Create operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"name": "string" Rule name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Delete
Delete operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Retrieve
Retrieve operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"name": "string" Rule name
}
]
}
}
RULE - Update
Update operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"name": "string" Rule name
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Create
Create operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"name": "string" Rule name
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Delete
Delete operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Retrieve
Retrieve operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
"name": "string" Rule name
}
]
}
ROOT-CAUSES - Update
Update operation of resource: root-causes
root-causesbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Create
Create operation of resource: root-causes
root-causesbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Delete
Delete operation of resource: root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Retrieve
Retrieve operation of resource: root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
}
ROOT-CAUSE - Update
Update operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Create
Create operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Delete
Delete operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Retrieve
Retrieve operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
NON-ROOT-CAUSES - Update
Update operation of resource: non-root-causes
non-root-causesbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Create
Create operation of resource: non-root-causes
non-root-causesbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Delete
Delete operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Retrieve
Retrieve operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
}
NON-ROOT-CAUSE - Update
Update operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Create
Create operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Delete
Delete operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Retrieve
Retrieve operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Request Content-Types: application/json
Request Example
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Request Content-Types: application/json
Request Example
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
RULE-SETS - Update
Update operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Create
Create operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Delete
Delete operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Retrieve
Retrieve operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
}
RULE-SET - Update
Update operation of resource: rule-set
rule-setbody object
ID of name
Request Content-Types: application/json
Request Example
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Create
Create operation of resource: rule-set
rule-setbody object
ID of name
Request Content-Types: application/json
Request Example
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Delete
Delete operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Retrieve
Retrieve operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
RULENAMES - Update
Update operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Create
Create operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Delete
Delete operation of resource: rulenames
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Retrieve
Retrieve operation of resource: rulenames
ID of name
RULENAME - Update
Update operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Create
Create operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Delete
Delete operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Retrieve
Retrieve operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Request Content-Types: application/json
Request Example
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Request Content-Types: application/json
Request Example
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
BULK-STATS - Update
Update operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{ "memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte" {
"retry": "integer", Number of transmission retries
range: "0..100"
default: "1" {
"schema-name": "string" The name of the schema
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
default: "240"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure schema name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}, {
"object-list-name": "string", Name of the object List {
"oid": "string" Object name or OID
}
]
},
"type": "null" Configure schema name
}
]
}, {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Create
Create operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{ "memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte" {
"retry": "integer", Number of transmission retries
range: "0..100"
default: "1" {
"schema-name": "string" The name of the schema
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
default: "240"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure schema name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}, {
"object-list-name": "string", Name of the object List {
"oid": "string" Object name or OID
}
]
},
"type": "null" Configure schema name
}
]
}, {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Delete
Delete operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Retrieve
Retrieve operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte" {
"retry": "integer", Number of transmission retries
range: "0..100"
default: "1" {
"schema-name": "string" The name of the schema
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
default: "240"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure schema name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}, {
"object-list-name": "string", Name of the object List {
"oid": "string" Object name or OID
}
]
},
"type": "null" Configure schema name
}
]
}, {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
}
SCHEMAS - Update
Update operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Create
Create operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Delete
Delete operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Retrieve
Retrieve operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
SCHEMA - Update
Update operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Create
Create operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Delete
Delete operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Retrieve
Retrieve operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
INSTANCE - Update
Update operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{ "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Type of the instance
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Create
Create operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{ "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Type of the instance
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Delete
Delete operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Retrieve
Retrieve operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Type of the instance
}
}
OBJECTS - Update
Update operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
Successful operation
Internal Error
OBJECTS - Update
Update operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
ID of object-list-name
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
TRANSFERS - Update
Update operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", Number of transmission retries
range: "0..100"
default: "1" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
default: "240"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Create
Create operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", Number of transmission retries
range: "0..100"
default: "1" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
default: "240"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Delete
Delete operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Retrieve
Retrieve operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"retry": "integer", Number of transmission retries
range: "0..100"
default: "1" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
default: "240"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
}
TRANSFER - Update
Update operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", Number of transmission retries
range: "0..100"
default: "1" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
default: "240"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Create
Create operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", Number of transmission retries
range: "0..100"
default: "1" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
default: "240"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Delete
Delete operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Retrieve
Retrieve operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"retry": "integer", Number of transmission retries
range: "0..100"
default: "1" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
default: "240"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
TRANSFER-SCHEMAS - Update
Update operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Create
Create operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Delete
Delete operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Retrieve
Retrieve operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
TRANSFER-SCHEMA - Update
Update operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Create
Create operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Delete
Delete operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Retrieve
Retrieve operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
DEFAULT-COMMUNITY-MAPS - Update
Update operation of resource: default-community-maps
default-community-mapsbody object
Request Content-Types: application/json
Request Example
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Create
Create operation of resource: default-community-maps
default-community-mapsbody object
Request Content-Types: application/json
Request Example
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Delete
Delete operation of resource: default-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: default-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
DEFAULT-COMMUNITY-MAP - Update
Update operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Create
Create operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Delete
Delete operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
OVERLOAD-CONTROL - Update
Update operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{ "drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Create
Create operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{ "drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Delete
Delete operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Retrieve
Retrieve operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"
}
}
TIMEOUTS - Update
Update operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{ "duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Create
Create operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{ "duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Delete
Delete operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Retrieve
Retrieve operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"
}
}
USERS - Update
Update operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Create
Create operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Delete
Delete operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Retrieve
Retrieve operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
}
USER - Update
Update operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Create
Create operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Delete
Delete operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
USER - Retrieve
Retrieve operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
ID of name
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
GROUPS - Update
Update operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Create
Create operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Delete
Delete operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Retrieve
Retrieve operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
}
GROUP - Update
Update operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Create
Create operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Delete
Delete operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Retrieve
Retrieve operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of context-name
Successful operation
Internal Error
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
MIB - Update
Update operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Create
Create operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Delete
Delete operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Retrieve
Retrieve operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{